home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / gt_power / luser12.zip / LISTUSER.DOC next >
Text File  |  1990-09-24  |  8KB  |  228 lines
  1.     =======================================
  2.  
  3.                LISTUSER v.1.2
  4.  
  5.         9/24/90            Chester Lin
  6.  
  7.     =======================================
  8.  
  9.     This package contains three programs: LOGONTM.EXE, LISTUSER.EXE,
  10.     and LISTUSER.DOC (this file).
  11.  
  12.  
  13.     < Revision History >
  14.  
  15.     V.1.1     8/27/90
  16.  
  17.     The first working version released to public.   Known bug: if user's name
  18.     is excessively long, the output file (GTLOGON.LST) may lose proper
  19.     alignment after the user's name.
  20.  
  21.  
  22.     V.1.2     9/24/90
  23.  
  24.     Bug in V.1.1 is fixed by truncating a user's name if it is too long
  25.     (longer than 17 characters)
  26.  
  27.  
  28.     < What is LISTUSER? >
  29.  
  30.     LISTUSER is a utility program for GT HOST BBS.  It can create a logon
  31.     listing file for user/sysop to review.  The listing file contains user's
  32.     logon date, logon time, logoff time, full name, modem speed, ANSI mode,
  33.     total logon time (in minutes), and total phone bill.
  34.  
  35.     LISTUSER will not add new entry into GTLOGON.LST and GTLOGON.CST if
  36.     the BBS is called from LOCAL mode, i.e. when called by the sysop locally.
  37.  
  38.  
  39.  
  40.     < How to use it? >
  41.  
  42.     It is rediculously simple to use LISTUSER.  Here is how:
  43.  
  44.     1. Put both LOGONTM.EXE and LISTUSER.EXE into your C:\GT (or any
  45.        directory specified by GTPATH) subdirectory.
  46.  
  47.     2. Change the default path to C:\GT (or where specified by
  48.        GTPATH).  This can be done in GTLOGON.BAT by adding the
  49.        following line:
  50.  
  51.                 CD C:\GT
  52.  
  53.     2. Call LOGONTM.EXE from your GTLOGON.BAT batch file.  This will
  54.        create a text file "GTLOGON.TM" which contains user's logon
  55.        date and time.  Just add the following line into the GTLOGON.BAT
  56.        file:
  57.  
  58.                 LOGONTM
  59.  
  60.     3. Change the default path to C:\GT within GTLOGOFF.BAT, just
  61.        before calling LISTUSER.EXE.  This can be done by adding the
  62.        following line to GTLOGOFF.BAT:
  63.  
  64.                 CD C:\GT
  65.  
  66.     3. Call LISTUSER.EXE from your GTLOGOFF.BAT batch file.  This will
  67.        create the listing file(s) you need to put into the bulletin.
  68.  
  69.        GTLOGON.TM and GTUSER.BBS must exist to let LISTUSER.EXE functions
  70.        properly; otherwise, LISTUSER will not create the listing files.
  71.        If you are wondering where those two files come from, let me tell
  72.        you.  GTLOGON.TM is a one-line text file created by LOGONTM.EXE
  73.        which was called within GTLOGON.BAT.  GTUSER.BBS is another one-line
  74.        text file created by GT HOST itself.
  75.  
  76.        Also LISTUSER.EXE will create one intermediate file holding
  77.        all the calling users' data (GTLOGON.L2).  Then it creates
  78.        GTLOGON.LST, and GTLOGON.CST _if_ the 'b' option is included in
  79.        the command line when you call LISTUSER.EXE.  If 'b' option is not
  80.        enabled, only GTLOGON.LST is be created.
  81.  
  82.        Please don't forget to change the default directory path to C:\GT
  83.        before calling LISTUSER.EXE, as in the case of LOGONTM.EXE.  Here
  84.        is an example of using LISTUSER within GTLOGOFF.BAT.  The switches
  85.        will be explained later.
  86.  
  87.                 LISTUSER [b] [n] $US$ t5 @0.15
  88.  
  89.     4. GTLOGON.LST is a non-ANSI version listing file created by
  90.        LISTUSER.EXE, and GTLOGON.CST is an ANSI version listing file
  91.        created by LISTUSER.EXE.
  92.  
  93.     5. Now you may add commands to copy GTLOGON.LST and GTLOGON.CST to
  94.        your bulletin area to be displayed.  You may invoke the copy
  95.        command in the logoff batch file.  For example:
  96.  
  97.                 COPY C:\GT\GTLOGON.LST C:\BULLETIN\10
  98.                 COPY C:\GT\GTLOGON.CST C:\BULLETIN\10.CBS
  99.  
  100.        The above two lines can be added into your logoff batch file.  They
  101.        will update bulletin #10 after the user logs off.
  102.  
  103.        Also you may rename the GTLOGON.LST and GTLOGON.CST in midnight
  104.        rollover, say, within the schedule batch file, to display yesterday's,
  105.        of day-before-yesterday's logon listing.
  106.  
  107.  
  108.  
  109.     < LISTUSER options >
  110.  
  111.     Version 1.1 LISTUSER accepts two options and three parameters
  112.     in the command line.
  113.  
  114.     The first option 'n' is to tell LISTUSER.EXE to use new format of
  115.     GTUSER.BBS (under GT Power 15.50).  If this option is not enabled,
  116.     then LISTUSER will assume the GTUSER.BBS used is in old format
  117.     (under GT 15.01).
  118.  
  119.     The second option is to tell LISTUSER.EXE to create two listing files:
  120.     GTLOGON.LST and GTLOGON.CST.  GTLOGON.LST is the non-ANSI version while
  121.     GTLOGON.CST is the ANSI version.  This option is enabled by adding 'b'
  122.     in the command line when calling LISTUSER.
  123.  
  124.  
  125.     Three parameters are mandatory for LISTUSER to display phone bill
  126.     information.  You must NOT omit any one of them!
  127.  
  128.     The first parameter is the currency name, it is supplied by using
  129.     the '$xxx' sign; 'xxx' is the name of the currency chosen.  Say,
  130.     if you want to display phone bill in U.S. dollar, just add the
  131.     following parameter after LISTUSER:
  132.  
  133.            $US$
  134.  
  135.     Or for Japanese Yen:
  136.  
  137.            $¥
  138.  
  139.     Or for New Taiwan dollar:
  140.  
  141.            $NT$
  142.  
  143.     Or for Deutsche Mark:
  144.  
  145.            $DM
  146.  
  147.     Or for Canadian Dollar:
  148.  
  149.            $CDN$
  150.  
  151.  
  152.     The second parameter tells LISTUSER how much time is used as the
  153.     basis to increment the phone bill.  This parameter is supplied by
  154.     adding 'txxx' to the command line, where 'xxx' is time in minute.
  155.     If the phone bill is charged every 5 minutes, then add 't5' in
  156.     LISTUSER command line.
  157.  
  158.     The third parameter tells LISTUSER how much money is charged for
  159.     every txxx minutes linked.  This can be done by adding '@xxx' in
  160.     LISTUSER command line.
  161.  
  162.     Several examples explain common usage of LISTUSER:
  163.  
  164.     (1) To use LISTUSER under GT 15.50, but you don't want the ANSI
  165.         version listing file, you may add the following line to your
  166.         logoff batch file:
  167.  
  168.            LISTUSER n $NT$ t5 @1.0
  169.  
  170.     (2) To invoke the two-file option under GT 15.01, add 'b' after
  171.         LISTUSER:
  172.  
  173.            LISTUSER b $CAN t10 @0.1
  174.  
  175.     (3) Of course you may also add both options after LISTUSER, to use the
  176.         new format option and to create two listing files under GT 15.50:
  177.  
  178.            LISTUSER n b $US$ t5 @0.25
  179.  
  180.               or
  181.  
  182.            LISTUSER b n $US$ t5 @0.25
  183.  
  184.  
  185.     (4) If you just want to run LISTUSER under GT 15.01, and only non-ANSI
  186.         listing file is desired, just call LISTUSER without any options:
  187.  
  188.            LISTUSER $DM t6 @0.31
  189.  
  190.     The order of 'n', 'b', $xxx, txxx, and @xxx is not important, but you
  191.     must use lower case letters for 'n', 'b', 't'.  Also don't omit the
  192.     blanks between each option and parameter, otherwise LISTUSER won't
  193.     'see' the supplied information.
  194.  
  195.  
  196.  
  197.     ------------------------------------------------------------------------
  198.  
  199.     I hope this small utility helps to make your BBS more interesting.
  200.     You are free to distribute this program without any commercial purposes.
  201.     My only request is that you include all three files when you give this
  202.     package to others. (LISTUSER.EXE, LOGONTM.EXE, and LISTUSER.DOC)
  203.  
  204.  
  205.     Also I would like to know how far this program is distributed.  So if
  206.     you get this program, please send me your local postcard to the following
  207.     address:
  208.  
  209.          Chester Lin
  210.          5-3 Lane 4 Pu Chen Street
  211.          Taipei, Taiwan 10611
  212.          Republic of China
  213.  
  214.     Or you may contact me through Mackey Mouse BBS at:
  215.  
  216.          886-02-3929997  (modem setting N-8-1-2400/1200)
  217.  
  218.     Or through CompuServe:
  219.  
  220.          Chester Lin
  221.          71510,3524
  222.  
  223.  
  224.  
  225.     Chester Lin
  226.     9/24/90
  227.     Taipei, Taiwan
  228.